home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib / tk / options.man < prev    next >
Encoding:
Text File  |  1992-08-24  |  21.4 KB  |  744 lines
  1. '\"
  2. '\" Copyright 1990 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/wish/man/RCS/options.man,v 1.12 92/07/14 11:36:10 ouster Exp $ SPRITE (Berkeley)
  11. '/" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '\"    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '\"    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '\"    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '\"    # BS - start boxed text
  93. '\"    # ^y = starting y location
  94. '\"    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '\"    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '\"    # VS - start vertical sidebar
  125. '\"    # ^Y = starting y location
  126. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '\"    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '\"    # Special macro to handle page bottom:  finish off current
  148. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '\"    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '\"    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '\"    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS options cmds
  189. .BS
  190. '\" Note:  do not modify the .SH NAME line immediately below!
  191. .SH NAME
  192. options \- Standard options supported by widgets
  193. .BE
  194.  
  195. .SH DESCRIPTION
  196. This manual entry describes the common configuration options supported
  197. by widgets in the Tk toolkit.  Every widget does not necessarily support
  198. every option (see the manual entries for individual widgets for a list
  199. of the standard options supported by that widget), but if a widget does
  200. support an option with one of the names listed below, then the option
  201. has exactly the effect described below.
  202. .PP
  203. In the descriptions below,
  204. ``Name'' refers to the option's name in the option database (e.g.
  205. in .Xdefaults files).  ``Class'' refers to the option's class value
  206. in the option database.  ``Command-Line Switch'' refers to the
  207. switch used in widget-creation and \fBconfigure\fR widget commands to
  208. set this value.  For example, if an option's command-line switch is
  209. \fB\-foreground\fR and there exists a widget \fB.a.b.c\fR, then the
  210. command
  211. .DS
  212. \&\fB.a.b.c\0\0configure\0\0\-foreground black\fR
  213. .DE
  214. may be used to specify the value \fBblack\fR for the option in the
  215. the widget \fB.a.b.c\fR.  Command-line switches may be abbreviated,
  216. as long as the abbreviation is unambiguous.
  217. .ta 4c
  218. .LP
  219. .nf
  220. Name:    \fBactiveBackground\fR
  221. Class:    \fBForeground\fR
  222. Command-Line Switch:    \fB\-activebackground\fR
  223. .fi
  224. .IP
  225. Specifies background color to use when drawing active elements.
  226. An element (a widget or portion of a widget) is active if the
  227. mouse cursor is positioned over the element and pressing a mouse button
  228. will cause some action to occur.
  229. .LP
  230. .nf
  231. Name:    \fBactiveBorderWidth\fR
  232. Class:    \fBBorderWidth\fR
  233. Command-Line Switch:    \fB\-activeborderwidth\fR
  234. .fi
  235. .IP
  236. Specifies a non-negative value indicating
  237. the width of the 3-D border drawn around active elements.  See above for
  238. definition of active elements.
  239. .VS
  240. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  241. .VE
  242. This option is typically only available in widgets displaying more
  243. than one element at a time (e.g. menus but not buttons).
  244. .LP
  245. .nf
  246. Name:    \fBactiveForeground\fR
  247. Class:    \fBBackground\fR
  248. Command-Line Switch:    \fB\-activeforeground\fR
  249. .fi
  250. .IP
  251. Specifies foreground color to use when drawing active elements.
  252. See above for definition of active elements.
  253. .LP
  254. .nf
  255. .VS
  256. Name:    \fBanchor\fR
  257. Class:    \fBAnchor\fR
  258. Command-Line Switch:    \fB\-anchor\fR
  259. .fi
  260. .IP
  261. Specifies how the information in a widget (e.g. text or a bitmap)
  262. is to be displayed in the widget.
  263. Must be one of the values \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR,
  264. \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR.
  265. For example, \fBnw\fR means display the information such that its
  266. top-left corner is at the top-left corner of the widget.
  267. .VE
  268. .LP
  269. .nf
  270. Name:    \fBbackground\fR
  271. Class:    \fBBackground\fR
  272. Command-Line Switch:    \fB\-background or \-bg\fR
  273. .fi
  274. .IP
  275. Specifies the normal background color to use when displaying the
  276. widget.
  277. .LP
  278. .nf
  279. Name:    \fBbitmap\fR
  280. .VS
  281. Class:    \fBBitmap\fR
  282. Command-Line Switch:    \fB\-bitmap\fR
  283. .fi
  284. .IP
  285. Specifies a bitmap to display in the widget, in any of the forms
  286. acceptable to \fBTk_GetBitmap\fR.
  287. The exact way in which the bitmap is displayed may be affected by
  288. other options such as \fBanchor\fR or \fBjustify\fR.
  289. Typically, if this option is specified then it overrides other
  290. options that specify a textual value to display in the widget;
  291. the \fBbitmap\fR option may be reset to an empty string to re-enable
  292. a text display.
  293. .VE
  294. .LP
  295. .nf
  296. Name:    \fBborderWidth\fR
  297. Class:    \fBBorderWidth\fR
  298. Command-Line Switch:    \fB\-borderwidth or \-bd\fR
  299. .fi
  300. .IP
  301. Specifies a non-negative value indicating the width
  302. of the 3-D border to draw around the outside of the widget (if such a
  303. border is being drawn;  the \fBrelief\fR option typically determines
  304. this).  The value may also be used when drawing 3-D effects in the
  305. interior of the widget.
  306. .VS
  307. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  308. .VE
  309. .LP
  310. .nf
  311. Name:    \fBcursor\fR
  312. Class:    \fBCursor\fR
  313. Command-Line Switch:    \fB\-cursor\fR
  314. .fi
  315. .IP
  316. Specifies the mouse cursor to be used for the widget.
  317. The value may have any of the forms acceptable to \fBTk_GetCursor\fR.
  318. .LP
  319. .nf
  320. Name:    \fBcursorBackground\fR
  321. Class:    \fBForeground\fR
  322. Command-Line Switch:    \fB\-cursorbackground\fR
  323. .fi
  324. .IP
  325. Specifies the color to use as background in the area covered by the
  326. insertion cursor.  This color will normally override either the normal
  327. background for the widget (or the selection background if the insertion
  328. cursor happens to fall in the selection).
  329. .VS
  330. \fIThis option is obsolete and is gradually being replaced by
  331. the \fBinsertBackground\fR option.\fR
  332. .VE
  333. .LP
  334. .nf
  335. Name:    \fBcursorBorderWidth\fR
  336. Class:    \fBBorderWidth\fR
  337. Command-Line Switch:    \fB\-cursorborderwidth\fR
  338. .fi
  339. .IP
  340. Specifies a non-negative value indicating the width
  341. of the 3-D border to draw around the insertion cursor.
  342. .VS
  343. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  344. \fIThis option is obsolete and is gradually being replaced by
  345. the \fBinsertBorderWidth\fR option.\fR
  346. .VE
  347. .LP
  348. .nf
  349. Name:    \fBcursorOffTime\fR
  350. Class:    \fBOffTime\fR
  351. Command-Line Switch:    \fB\-cursorofftime\fR
  352. .fi
  353. .IP
  354. Specifies a non-negative integer value indicating the number of
  355. milliseconds the cursor should remain ``off'' in each blink cycle.
  356. If this option is zero then the cursor doesn't blink:  it is on
  357. all the time.
  358. .VS
  359. \fIThis option is obsolete and is gradually being replaced by
  360. the \fBinsertOffTime\fR option.\fR
  361. .VE
  362. .LP
  363. .nf
  364. Name:    \fBcursorOnTime\fR
  365. Class:    \fBOnTime\fR
  366. Command-Line Switch:    \fB\-cursorontime\fR
  367. .fi
  368. .IP
  369. Specifies a non-negative integer value indicating the number of
  370. milliseconds the cursor should remain ``on'' in each blink cycle.
  371. .VS
  372. \fIThis option is obsolete and is gradually being replaced by
  373. the \fBinsertOnTime\fR option.\fR
  374. .VE
  375. .LP
  376. .nf
  377. Name:    \fBcursorWidth\fR
  378. Class:    \fBCursorWidth\fR
  379. Command-Line Switch:    \fB\-cursorwidth\fR
  380. .fi
  381. .IP
  382. Specifies a  value indicating the total width of the insertion cursor.
  383. .VS
  384. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  385. .VE
  386. If a border has been specified for
  387. the cursor (using the \fBcursorBorderWidth\fR option), the border
  388. will be drawn inside the width specified by the \fBcursorWidth\fR
  389. option.
  390. .VS
  391. \fIThis option is obsolete and is gradually being replaced by
  392. the \fBinsertWidth\fR option.\fR
  393. .VE
  394. .LP
  395. .nf
  396. .VS
  397. Name:    \fBdisabledForeground\fR
  398. Class:    \fBDisabledForeground\fR
  399. Command-Line Switch:    \fB\-disabledforeground\fR
  400. .fi
  401. .IP
  402. Specifies foreground color to use when drawing a disabled element.
  403. If the option is specified as an empty string (which is typically the
  404. case on monochrome displays), disabled elements are drawn with the
  405. normal fooreground color but they are dimmed by drawing them
  406. with a stippled fill pattern.
  407. .VE
  408. .LP
  409. .nf
  410. .VS
  411. Name:    \fBexportSelection\fR
  412. Class:    \fBExportSelection\fR
  413. Command-Line Switch:    \fB\-exportselection\fR
  414. .fi
  415. .IP
  416. Specifies whether or not a selection in the widget should also be
  417. the X selection.
  418. The value may have any of the forms accepted by \fBTcl_GetBoolean\fR,
  419. such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR, \fByes\fR, or \fBno\fR.
  420. If the selection is exported, then selecting in the widget deselects
  421. the current X selection, selecting outside the widget deselects any
  422. widget selection, and the widget will respond to selection retrieval
  423. requests when it has a selection.  The default is usually for widgets
  424. to export selections.
  425. .VE
  426. .LP
  427. .nf
  428. Name:    \fBfont\fR
  429. Class:    \fBFont\fR
  430. Command-Line Switch:    \fB\-font\fR
  431. .fi
  432. .IP
  433. Specifies the font to use when drawing text inside the widget.
  434. .LP
  435. .nf
  436. Name:    \fBforeground\fR
  437. Class:    \fBForeground\fR
  438. Command-Line Switch:    \fB\-foreground or \-fg\fR
  439. .fi
  440. .IP
  441. Specifies the normal foreground color to use when displaying the widget.
  442. .LP
  443. .nf
  444. Name:    \fBgeometry\fR
  445. Class:    \fBGeometry\fR
  446. Command-Line Switch:    \fB\-geometry\fR
  447. .fi
  448. .IP
  449. Specifies the desired geometry for the widget's window, in the
  450. form \fIwidth\fBx\fIheight\fR, where \fIwidth\fR is the desired
  451. width of the window and \fIheight\fR is the desired height.  The
  452. units for \fIwidth\fR and \fIheight\fR depend on the particular
  453. widget.  For widgets displaying text the units are usually the
  454. size of the characters in the font being displayed;  for other
  455. widgets the units are usually pixels.
  456. .LP
  457. .nf
  458. .VS
  459. Name:    \fBinsertBackground\fR
  460. Class:    \fBForeground\fR
  461. Command-Line Switch:    \fB\-insertbackground\fR
  462. .fi
  463. .IP
  464. Specifies the color to use as background in the area covered by the
  465. insertion cursor.  This color will normally override either the normal
  466. background for the widget (or the selection background if the insertion
  467. cursor happens to fall in the selection).
  468. .LP
  469. .nf
  470. Name:    \fBinsertBorderWidth\fR
  471. Class:    \fBBorderWidth\fR
  472. Command-Line Switch:    \fB\-insertborderwidth\fR
  473. .fi
  474. .IP
  475. Specifies a non-negative value indicating the width
  476. of the 3-D border to draw around the insertion cursor.
  477. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  478. .LP
  479. .nf
  480. Name:    \fBinsertOffTime\fR
  481. Class:    \fBOffTime\fR
  482. Command-Line Switch:    \fB\-insertofftime\fR
  483. .fi
  484. .IP
  485. Specifies a non-negative integer value indicating the number of
  486. milliseconds the insertion cursor should remain ``off'' in each blink cycle.
  487. If this option is zero then the cursor doesn't blink:  it is on
  488. all the time.
  489. .LP
  490. .nf
  491. Name:    \fBinsertOnTime\fR
  492. Class:    \fBOnTime\fR
  493. Command-Line Switch:    \fB\-insertontime\fR
  494. .fi
  495. .IP
  496. Specifies a non-negative integer value indicating the number of
  497. milliseconds the insertion cursor should remain ``on'' in each blink cycle.
  498. .LP
  499. .nf
  500. Name:    \fBinsertWidth\fR
  501. Class:    \fBInsertWidth\fR
  502. Command-Line Switch:    \fB\-insertwidth\fR
  503. .fi
  504. .IP
  505. Specifies a  value indicating the total width of the insertion cursor.
  506. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  507. If a border has been specified for the insertion
  508. cursor (using the \fBinsertBorderWidth\fR option), the border
  509. will be drawn inside the width specified by the \fBinsertWidth\fR
  510. option.
  511. .VE
  512. .LP
  513. .nf
  514. Name:    \fBorient\fR
  515. Class:    \fBOrient\fR
  516. Command-Line Switch:    \fB\-orient\fR
  517. .fi
  518. .IP
  519. For widgets that can lay themselves out with either a horizontal
  520. or vertical orientation, such as scrollbars, this option specifies
  521. which orientation should be used.  Must be either \fBhorizontal\fR
  522. or \fBvertical\fR or an abbreviation of one of these.
  523. .LP
  524. .nf
  525. Name:    \fBpadX\fR
  526. Class:    \fBPad\fR
  527. Command-Line Switch:    \fB\-padx\fR
  528. .fi
  529. .IP
  530. Specifies a non-negative value indicating how much extra space
  531. to request for the widget in the X-direction.
  532. .VS
  533. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  534. .VE
  535. When computing how large a window it needs, the widget will
  536. add this amount to the width it would normally need (as determined
  537. by the width of the things displayed in the widget);  if the geometry
  538. manager can satisfy this request, the widget will end up with extra
  539. internal space to the left and/or right of what it displays inside.
  540. .LP
  541. .nf
  542. Name:    \fBpadY\fR
  543. Class:    \fBPad\fR
  544. Command-Line Switch:    \fB\-pady\fR
  545. .fi
  546. .IP
  547. Specifies a non-negative value indicating how much extra space
  548. to request for the widget in the Y-direction.
  549. .VS
  550. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  551. .VE
  552. When computing how large a window it needs, the widget will add
  553. this amount to the height it would normally need (as determined by
  554. the height of the things displayed in the widget);  if the geometry
  555. manager can satisfy this request, the widget will end up with extra
  556. internal space above and/or below what it displays inside.
  557. .LP
  558. .nf
  559. Name:    \fBrelief\fR
  560. Class:    \fBRelief\fR
  561. Command-Line Switch:    \fB\-relief\fR
  562. .fi
  563. .IP
  564. Specifies the 3-D effect desired for the widget.  Acceptable
  565. values are \fBraised\fR, \fBsunken\fR, and \fBflat\fR.  The value
  566. indicates how the interior of the widget should appear relative
  567. to its exterior;  for example, \fBraised\fR means the interior of
  568. the widget should appear to protrude from the screen, relative to
  569. the exterior of the widget.
  570. .LP
  571. .nf
  572. Name:    \fBrepeatDelay\fR
  573. Class:    \fBRepeatDelay\fR
  574. Command-Line Switch:    \fB\-repeatdelay\fR
  575. .fi
  576. .IP
  577. Specifies the number of milliseconds a button or key must be held
  578. down before it begins to auto-repeat.  Used, for example, on the
  579. up- and down-arrows in scrollbars.
  580. .LP
  581. .nf
  582. Name:    \fBrepeatInterval\fR
  583. Class:    \fBRepeatInterval\fR
  584. Command-Line Switch:    \fB\-repeatinterval\fR
  585. .fi
  586. .IP
  587. Used in conjunction with \fBrepeatDelay\fR:  once auto-repeat
  588. begins, this option determines the number of milliseconds between
  589. auto-repeats.
  590. .LP
  591. .nf
  592. Name:    \fBscrollCommand\fR
  593. Class:    \fBScrollCommand\fR
  594. Command-Line Switch:    \fB\-scrollcommand\fR
  595. .fi
  596. .IP
  597. Specifies the prefix for a command used to communicate with scrollbar
  598. widgets.  When the view in the widget's window changes (or
  599. whenever anything else occurs that could change the display in a
  600. scrollbar, such as a change in the total size of the widget's
  601. contents), the widget will
  602. generate a Tcl command by concatenating the scroll command and four
  603. numbers.  The four numbers are, in order:  the total size of the
  604. widget's contents, in unspecified units
  605. (``unit'' is a widget-specific term;  for widgets
  606. displaying text, the unit is a line);  the maximum number of units that
  607. may be displayed at once in the widget's window, given its current size;  the
  608. index of the top-most or left-most unit currently visible in the window
  609. (index 0 corresponds to the first unit); and the index of the bottom-most
  610. or right-most unit currently visible in the window.  This command is
  611. then passed to the Tcl interpreter for execution.  Typically the
  612. \fBscrollCommand\fR option consists of the path name of a scrollbar
  613. widget followed by ``set'', e.g. ``.x.scrollbar set'':  this will cause
  614. the scrollbar to be updated whenever the view in the window changes.
  615. If this option is not specified, then no command will be executed.
  616. .IP
  617. .VS
  618. The \fBscrollCommand\fR option is used for widgets that support scrolling
  619. in only one direction.
  620. For widgets that support scrolling in both directions, this
  621. option is replaced with the \fBxScrollCommand\fR and \fByScrollCommand\fR
  622. options.
  623. .VE
  624. .LP
  625. .nf
  626. Name:    \fBselectBackground\fR
  627. Class:    \fBForeground\fR
  628. Command-Line Switch:    \fB\-selectbackground\fR
  629. .fi
  630. .IP
  631. Specifies the background color to use when displaying selected
  632. items.
  633. .LP
  634. .nf
  635. Name:    \fBselectBorderWidth\fR
  636. Class:    \fBBorderWidth\fR
  637. Command-Line Switch:    \fB\-selectborderwidth\fR
  638. .fi
  639. .IP
  640. Specifies a non-negative value indicating the width
  641. of the 3-D border to draw around selected items.
  642. .VS
  643. The value may have any of the forms acceptable to \fBTk_GetPixels\fR.
  644. .VE
  645. .LP
  646. .nf
  647. Name:    \fBselectForeground\fR
  648. Class:    \fBBackground\fR
  649. Command-Line Switch:    \fB\-selectforeground\fR
  650. .fi
  651. .IP
  652. Specifies the foreground color to use when displaying selected
  653. items.
  654. .LP
  655. .nf
  656. .VS
  657. Name:    \fBsetGrid\fR
  658. Class:    \fBSetGrid\fR
  659. Command-Line Switch:    \fB\-setgrid\fR
  660. .fi
  661. .IP
  662. Specifies a boolean value that determines whether this widget controls the
  663. resizing grid for its top-level window.
  664. This option is typically used in text widgets, where the information
  665. in the widget has a natural size (the size of a character) and it makes
  666. sense for the window's dimensions to be integral numbers of these units.
  667. These natural window sizes form a grid.
  668. If the \fBsetGrid\fR option is set to true then the widget will
  669. communicate with the window manager so that when the user interactively
  670. resizes the top-level window that contains the widget, the dimensions of
  671. the window will be displayed to the user in grid units and the window
  672. size will be constrained to integral numbers of grid units.
  673. See the section GRIDDED GEOMETRY MANAGEMENT in the \fBwm\fR manual
  674. entry for more details.
  675. .VE
  676. .LP
  677. .nf
  678. Name:    \fBtext\fR
  679. Class:    \fBText\fR
  680. Command-Line Switch:    \fB\-text\fR
  681. .fi
  682. .IP
  683. Specifies a string to be displayed inside the widget.  The way in which
  684. the string is displayed depends on the particular widget and may be
  685. determined by other options, such as \fBanchor\fR or \fBjustify\fR.
  686. .LP
  687. .nf
  688. .VS
  689. Name:    \fBtextVariable\fR
  690. Class:    \fBVariable\fR
  691. Command-Line Switch:    \fB\-textvariable\fR
  692. .fi
  693. .IP
  694. Specifies the name of a variable.  The value of the variable is a text
  695. string to be displayed inside the widget;  if the variable value changes
  696. then the widget will automatically update itself to reflect the new value.
  697. The way in which the string is displayed in the widget depends on the
  698. particular widget and may be determined by other options, such as
  699. \fBanchor\fR or \fBjustify\fR.
  700. .LP
  701. .nf
  702. Name:    \fBunderline\fR
  703. Class:    \fBUnderline\fR
  704. Command-Line Switch:    \fB\-underline\fR
  705. .fi
  706. .IP
  707. Specifies the integer index of a character to underline in the widget.
  708. This option is typically used to indicate keyboard traversal characters
  709. in menu buttons and menu entries.  0 corresponds to the first character
  710. of the text displayed in the widget, 1 to the next character, and so
  711. on.
  712. .LP
  713. .nf
  714. Name:    \fBxScrollCommand\fR
  715. Class:    \fBScrollCommand\fR
  716. Command-Line Switch:    \fB\-xscrollcommand\fR
  717. .fi
  718. .IP
  719. Specifies the prefix for a command used to communicate with horizontal
  720. scrollbars.  This option is treated in the same way as the
  721. \fBscrollCommand\fR option, except that it is used for horizontal
  722. scrollbars associated with widgets that support both horizontal
  723. and vertical scrolling.
  724. See the description of \fBscrollCommand\fR for complete details
  725. on how this option is used.
  726. .LP
  727. .nf
  728. Name:    \fByScrollCommand\fR
  729. Class:    \fBScrollCommand\fR
  730. Command-Line Switch:    \fB\-yscrollcommand\fR
  731. .fi
  732. .IP
  733. Specifies the prefix for a command used to communicate with vertical
  734. scrollbars.  This option is treated in the same way as the
  735. \fBscrollCommand\fR option, except that it is used for vertical
  736. scrollbars associated with widgets that support both horizontal
  737. and vertical scrolling.
  738. See the description of \fBscrollCommand\fR for complete details
  739. on how this option is used.
  740. .VE
  741.  
  742. .SH KEYWORDS
  743. class, name, standard option, switch
  744.